StartFunction Method (string, string, object[], object[])
Runs an XJEase function with the specified name from the given device's test device file. The XJEase function is run asynchronously i.e. control returns immediately from this method and the XJEase code continues to run on a separate thread.
Type: Runner
Namespace: XJTAG.Integration.XJRunner
Syntax
public void StartFunction(string device, string functionName, object[] inputArgs, object[] outputArgs)
Parameters
- device
Type: string
The name of the device on which to run the function. If there are multiple boards in the project, the device name should be in the form Board.Device.
- functionName
Type: string
The name of the XJEase test function to run.
- inputArgs
Type: object[]
The input arguments for the function. An arbitrary number of string and integer arguments can be given, corresponding to the parameters for the function to be run.
- outputArgs
Type: object[]
The initial values for the output arguments; individual arguments can be initialised as null.
Exceptions
- RuntimeException
There was an error running the XJEase code.
- System.ArgumentException
The function name was an empty string.
- System.ArgumentNullException
Any of the arguments were null.
- System.ObjectDisposedException
The Runner has already been disposed.
Remarks
The XJEase code is run on a separate thread, and the calling application is notified when it is completed via the FunctionFinished event. The outputs of the XJEase function run are given by the Outputs field of FunctionFinishedEventArgs.
The WaitForCompletion method must be called or the WaitForCompletion method must be called and return successfully before attempting to start running any other function. The StopFunction method can be called to abort the function.
XJTAG v4.2.5